home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / PInterfaces / DigitalSignature.p < prev    next >
Text File  |  1996-05-01  |  17KB  |  388 lines
  1. {
  2.      File:        DigitalSignature.p
  3.  
  4.      Contains:    Digital Signature Interfaces.
  5.  
  6.      Version:    Technology:    AOCE toolbox 1.02
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT DigitalSignature;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __DIGITALSIGNATURE__}
  28. {$SETC __DIGITALSIGNATURE__ := 1}
  29.  
  30. {$I+}
  31. {$SETC DigitalSignatureIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __TYPES__}
  35. {$I Types.p}
  36. {$ENDC}
  37. {$IFC UNDEFINED __MEMORY__}
  38. {$I Memory.p}
  39. {$ENDC}
  40. {$IFC UNDEFINED __FILES__}
  41. {$I Files.p}
  42. {$ENDC}
  43.  
  44. {$PUSH}
  45. {$ALIGN MAC68K}
  46. {$LibExport+}
  47.  
  48. {$IFC FOR_SYSTEM7_ONLY }
  49. {  values of SIGNameAttributeType  }
  50.  
  51. CONST
  52.     kSIGCountryCode                = 0;
  53.     kSIGOrganization            = 1;
  54.     kSIGStreetAddress            = 2;
  55.     kSIGState                    = 3;
  56.     kSIGLocality                = 4;
  57.     kSIGCommonName                = 5;
  58.     kSIGTitle                    = 6;
  59.     kSIGOrganizationUnit        = 7;
  60.     kSIGPostalCode                = 8;
  61.  
  62.  
  63. TYPE
  64.     SIGNameAttributeType                = INTEGER;
  65. {
  66. Certificate status codes returned in SIGCertInfo or SIGSignerInfo from
  67. either SIGGetCertInfo or SIGGetSignerInfo respectively. kSIGValid means that
  68. the certificate is currently valid. kSIGPending means the certificate is
  69. currently not valid - but will be.  kSIGExpired means the certificate has
  70. expired. A time is always associated with a SIGCertStatus.  In each case the
  71. time has a specific interpretation.  When the status is kSIGValid the time is
  72. when the certificate will expire. When the status is kSIGPending the time is
  73. when the certificate will become valid. When the status is kSIGExpired the time
  74. is when the certificate expired. In the SIGCertInfo structure, the startDate
  75. and endDate fields hold the appropriate date information.  In the SIGSignerInfo
  76. structure, this information is provided in the certSetStatusTime field. In the
  77. SIGSignerInfo struct, the status time is actually represented by the SIGSignatureStatus
  78. field which can contain any of the types below. NOTE: The only time you will get 
  79. a kSIGInvalid status is when it pertains to a SIGSignatureStatus field and only when
  80. you get a signature that was created after the certificates expiration date, something
  81. we are not allowing on the Mac but that may not be restricted on other platforms. Also, 
  82. it will not be possible to get a kSIGPending value for SIGSignatureStatus on the Mac but
  83. possibly allowed by other platforms.
  84. }
  85. {  Values for SIGCertStatus or SIGSignatureStatus  }
  86.  
  87. CONST
  88.     kSIGValid                    = 0;                            {  possible for either a SIGCertStatus or SIGSignatureStatus  }
  89.     kSIGPending                    = 1;                            {  possible for either a SIGCertStatus or SIGSignatureStatus  }
  90.     kSIGExpired                    = 2;                            {  possible for either a SIGCertStatus or SIGSignatureStatus * possible only for a SIGSignatureStatus  }
  91.     kSIGInvalid                    = 3;
  92.  
  93.  
  94. TYPE
  95.     SIGCertStatus                        = INTEGER;
  96.     SIGSignatureStatus                    = INTEGER;
  97. {  Gestalt selector code - returns toolbox version in low-order word  }
  98.  
  99. CONST
  100.     gestaltDigitalSignatureVersion = 'dsig';
  101.  
  102. {  Number of bytes needed for a digest record when using SIGDigest  }
  103.     kSIGDigestSize                = 16;
  104.  
  105.  
  106. TYPE
  107.     SIGDigestData                        = PACKED ARRAY [0..15] OF Byte;
  108.     SIGDigestDataPtr                    = ^Byte;
  109.     SIGCertInfoPtr = ^SIGCertInfo;
  110.     SIGCertInfo = RECORD
  111.         startDate:                LONGINT;                                {  cert start validity date  }
  112.         endDate:                LONGINT;                                {  cert end validity date  }
  113.         certStatus:                SIGCertStatus;                            {  see comment on SIGCertStatus for definition  }
  114.         certAttributeCount:        LONGINT;                                {  number of name attributes in this cert  }
  115.         issuerAttributeCount:    LONGINT;                                {  number of name attributes in this certs issuer  }
  116.         serialNumber:            Str255;                                    {  cert serial number  }
  117.     END;
  118.  
  119.     SIGSignerInfoPtr = ^SIGSignerInfo;
  120.     SIGSignerInfo = RECORD
  121.         signingTime:            LONGINT;                                {  time of signing  }
  122.         certCount:                LONGINT;                                {  number of certificates in the cert set  }
  123.         certSetStatusTime:        LONGINT;                                {  Worst cert status time. See comment on SIGCertStatus for definition  }
  124.         signatureStatus:        SIGSignatureStatus;                        {  The status of the signature. See comment on SIGCertStatus for definition }
  125.     END;
  126.  
  127.     SIGNameAttributesInfoPtr = ^SIGNameAttributesInfo;
  128.     SIGNameAttributesInfo = RECORD
  129.         onNewLevel:                BOOLEAN;
  130.         filler1:                BOOLEAN;
  131.         attributeType:            SIGNameAttributeType;
  132.         attributeScript:        ScriptCode;
  133.         attribute:                Str255;
  134.     END;
  135.  
  136.     SIGContextPtr                        = Ptr;
  137.     SIGSignaturePtr                        = Ptr;
  138. {
  139. Certificates are always in order. That is, the signers cert is always 0, the
  140. issuer of the signers cert is always 1 etc... to the number of certificates-1.
  141. You can use this constant for readability in your code.
  142. }
  143.  
  144. CONST
  145.     kSIGSignerCertIndex            = 0;
  146.  
  147. {
  148. Call back procedure supplied by developer, return false to cancel the current
  149. process.
  150. }
  151.  
  152. TYPE
  153.     SIGStatusProcPtr = ProcPtr;  { FUNCTION SIGStatus: BOOLEAN; }
  154.  
  155.     SIGStatusUPP = UniversalProcPtr;
  156.  
  157. CONST
  158.     uppSIGStatusProcInfo = $00000010;
  159.  
  160. FUNCTION NewSIGStatusProc(userRoutine: SIGStatusProcPtr): SIGStatusUPP;
  161.     {$IFC NOT GENERATINGCFM }
  162.     INLINE $2E9F;
  163.     {$ENDC}
  164.  
  165. FUNCTION CallSIGStatusProc(userRoutine: SIGStatusUPP): BOOLEAN;
  166.     {$IFC NOT GENERATINGCFM}
  167.     INLINE $205F, $4E90;
  168.     {$ENDC}
  169. {
  170. Resource id's of standard signature icon suite, all sizes and colors are available.
  171. }
  172.  
  173. CONST
  174.     kSIGSignatureIconResID        = -16797;
  175.     kSIGValidSignatureIconResID    = -16799;
  176.     kSIGInvalidSignatureIconResID = -16798;
  177.  
  178. {
  179.  -------------------------------------------------------------- CONTEXT CALLS -------------------------------------------------------------- 
  180. To use the Digital Signature toolbox you will need a SIGContextPtr.  To create
  181. a SIGContextPtr you simply call SIGNewContext and it will create and initialize
  182. a context for you.  To free the memory occupied by the context and invalidate
  183. its internal data, call SIGDisposeContext. An initialized context has no notion
  184. of the type of operation it will be performing however, once you call
  185. SIGSignPrepare SIGVerifyPrepare, or SIGDigestPrepare, the contexts operation
  186. type is set and to switch  to another type of operation will require creating a
  187. new context. Be sure to pass the same context to corresponding toolbox calls
  188. (ie SIGSignPrepare, SIGProcessData, SIGSign)  in other words mixing lets say
  189. signing and verify calls with the same context is not allowed.
  190. }
  191. FUNCTION SIGNewContext(VAR context: SIGContextPtr): OSErr;
  192.     {$IFC NOT GENERATINGCFM}
  193.     INLINE $203C, $0002, $076C, $AA5D;
  194.     {$ENDC}
  195. FUNCTION SIGDisposeContext(context: SIGContextPtr): OSErr;
  196.     {$IFC NOT GENERATINGCFM}
  197.     INLINE $203C, $0002, $076D, $AA5D;
  198.     {$ENDC}
  199. {
  200.  -------------------------------------------------------------- SIGNING CALLS -------------------------------------------------------------- 
  201. Once you have created a SIGContextPtr, you create a signature by calling
  202. SIGSignPrepare once, followed by n calls to SIGProcessData, followed by one call
  203. toRcpt SIGSign. To create another signature on different data but for the same
  204. signer, don't dispose of the context and call SIGProcessData for the new data
  205. followed by a call SIGSign again. In this case the signer will not be prompted
  206. for their signer and password again as it was already provided.  Once you call
  207. SIGDisposeContext, all signer information will be cleared out of the context and
  208. the signer will be re-prompted.  The signer file FSSpecPtr should be set to nil
  209. if you want the toolbox to use the last signer by default or prompt for a signer
  210. if none exists.  The prompt parameter can be used to pass a string to be displayed
  211. in the dialog that prompts the user for their password.  If the substring "^1"
  212. (without the quotes) is in the prompt string, then the toolbox will replace it
  213. with the name of the signer from the signer selected by the user.  If an empty
  214. string is passed, the following default string will be sent to the toolbox
  215. "\pSigning as ^1.".  You can call any of the utility routines after SIGSignPrepare
  216. or SIGSign to get information about the signer or certs.
  217. }
  218. FUNCTION SIGSignPrepare(context: SIGContextPtr; {CONST}VAR signerFile: FSSpec; prompt: Str255; VAR signatureSize: Size): OSErr;
  219.     {$IFC NOT GENERATINGCFM}
  220.     INLINE $203C, $0008, $076E, $AA5D;
  221.     {$ENDC}
  222. FUNCTION SIGSign(context: SIGContextPtr; signature: SIGSignaturePtr; statusProc: SIGStatusProcPtr): OSErr;
  223.     {$IFC NOT GENERATINGCFM}
  224.     INLINE $203C, $0006, $076F, $AA5D;
  225.     {$ENDC}
  226. {
  227.  -------------------------------------------------------------- VERIFYING CALLS -------------------------------------------------------------- 
  228. Once you have created a SIGContextPtr, you verify a signature by calling
  229. SIGVerifyPrepare  once, followed by n calls to SIGProcessData, followed by one
  230. call to SIGVerify. Check the return code from SIGVerify to see if the signature
  231. verified or not (noErr is returned on  success otherwise the appropriate error
  232. code).  Upon successfull verification, you can call any of the utility routines
  233. toRcpt find out who signed the data.
  234. }
  235. FUNCTION SIGVerifyPrepare(context: SIGContextPtr; signature: SIGSignaturePtr; signatureSize: Size; statusProc: SIGStatusProcPtr): OSErr;
  236.     {$IFC NOT GENERATINGCFM}
  237.     INLINE $203C, $0008, $0770, $AA5D;
  238.     {$ENDC}
  239. FUNCTION SIGVerify(context: SIGContextPtr): OSErr;
  240.     {$IFC NOT GENERATINGCFM}
  241.     INLINE $203C, $0002, $0771, $AA5D;
  242.     {$ENDC}
  243. {
  244.  ------------------------------------------------------------ DIGESTING CALLS ------------------------------------------------------------ 
  245. Once you have created a SIGContextPtr, you create a digest by calling
  246. SIGDigestPrepare once, followed by n calls to SIGProcessData, followed by one
  247. call to SIGDigest.  You can dispose of the context after SIGDigest as the
  248. SIGDigestData does not reference back into it.  SIGDigest returns the digest in
  249. digest.
  250. }
  251. FUNCTION SIGDigestPrepare(context: SIGContextPtr): OSErr;
  252.     {$IFC NOT GENERATINGCFM}
  253.     INLINE $203C, $0002, $0772, $AA5D;
  254.     {$ENDC}
  255. FUNCTION SIGDigest(context: SIGContextPtr; VAR digest: SIGDigestData): OSErr;
  256.     {$IFC NOT GENERATINGCFM}
  257.     INLINE $203C, $0004, $0773, $AA5D;
  258.     {$ENDC}
  259. {
  260.  ------------------------------------------------------------ PROCESSING DATA ------------------------------------------------------------ 
  261. To process data during a digest, sign, or verify operation call SIGProcessData
  262. as many times as necessary and with any sized blocks of data.  The data needs to
  263. be processed in the same order during corresponding sign and verify operations
  264. but does not need to be processed in the same sized chunks (i.e., the toolbox
  265. just sees it as a continuous bit stream).
  266. }
  267. FUNCTION SIGProcessData(context: SIGContextPtr; data: UNIV Ptr; dataSize: Size): OSErr;
  268.     {$IFC NOT GENERATINGCFM}
  269.     INLINE $203C, $0006, $0774, $AA5D;
  270.     {$ENDC}
  271. {
  272.  -------------------------------------------------------------- UTILITY CALLS -------------------------------------------------------------- 
  273. Given a context that has successfully performed a verification SIGShowSigner
  274. will  display a modal dialog with the entire distinguished name of the person
  275. who signed the data. the prompt (if supplied) will appear at the top of the
  276. dialog.  If no prompt is specified, the default prompt "\pVerification
  277. Successfull." will appear.
  278.  
  279. Given a context that has been populated by calling SIGSignPrepare, SIGSign or a
  280. successful SIGVerify, you can make the remaining utility calls:
  281.  
  282. SIGGetSignerInfo will return the SignerInfo record.  The certCount can be used
  283. toRcpt index into the certificate set when calling SIGGetCertInfo,
  284. SIGGetCertNameAttributes or SIGGetCertIssuerNameAttributes. The signingTime is
  285. only defined if the call is made after SIGSign  or SIGVerify. The certSetStatus
  286. will tell you the best status of the entire certificate set while
  287. certSetStatusTime will correspond to the time associated with that status (see
  288. definitions above).
  289.  
  290. SIGGetCertInfo will return the SIGCertInfo record when given a valid index into
  291. the cert set in  certIndex.  Note: The cert at index kSIGSignerCertIndex is
  292. always the signers certificate.  The  serial number, start date and end date
  293. are there should you wish to display that info.  The  certAttributeCount and
  294. issuerAttributeCount provide the number of parts in the name of that certificate
  295. or that certificates issuer respectively.  You use these numbers to index into
  296. either SIGGetCertNameAttributes or SIGGetCertIssuerNameAttributes to retrieve
  297. the name. The certStatus will tell you the status of the certificate while
  298. certStatusTime will correspond to the time associated with that status (see
  299. definitions above).
  300.  
  301. SIGGetCertNameAttributes and SIGGetCertIssuerNameAttributes return name parts
  302. of the certificate at  certIndex and attributeIndex.  The newLevel return value
  303. tells you wether the name attribute returned is at the same level in the name
  304. hierarchy as the previous attribute.  The type return value tells you  the type
  305. of attribute returned. nameAttribute is the actual string containing the name
  306. attribute.   So, if you wanted to display the entire distinguished name of the
  307. person who's signature was just validated you could do something like this;
  308.  
  309.     (...... variable declarations and verification code would preceed this sample ......)
  310.  
  311.     error = SIGGetCertInfo(verifyContext, kSIGSignerCertIndex, &certInfo);
  312.     HandleErr(error);
  313.  
  314.     for (i = 0; i <= certInfo.certAttributeCount-1; i++)
  315.         (
  316.         error = SIGGetCertNameAttributes(
  317.             verifyContext, kSIGSignerCertIndex, i, &newLevel, &type, theAttribute);
  318.         HandleErr(error);
  319.         DisplayNamePart(theAttribute, type, newLevel);
  320.         )
  321. }
  322. FUNCTION SIGShowSigner(context: SIGContextPtr; prompt: Str255): OSErr;
  323.     {$IFC NOT GENERATINGCFM}
  324.     INLINE $203C, $0004, $0775, $AA5D;
  325.     {$ENDC}
  326. FUNCTION SIGGetSignerInfo(context: SIGContextPtr; VAR signerInfo: SIGSignerInfo): OSErr;
  327.     {$IFC NOT GENERATINGCFM}
  328.     INLINE $203C, $0004, $0776, $AA5D;
  329.     {$ENDC}
  330. FUNCTION SIGGetCertInfo(context: SIGContextPtr; certIndex: LONGINT; VAR certInfo: SIGCertInfo): OSErr;
  331.     {$IFC NOT GENERATINGCFM}
  332.     INLINE $203C, $0006, $0777, $AA5D;
  333.     {$ENDC}
  334. FUNCTION SIGGetCertNameAttributes(context: SIGContextPtr; certIndex: LONGINT; attributeIndex: LONGINT; VAR attributeInfo: SIGNameAttributesInfo): OSErr;
  335.     {$IFC NOT GENERATINGCFM}
  336.     INLINE $203C, $0008, $0778, $AA5D;
  337.     {$ENDC}
  338. FUNCTION SIGGetCertIssuerNameAttributes(context: SIGContextPtr; certIndex: LONGINT; attributeIndex: LONGINT; VAR attributeInfo: SIGNameAttributesInfo): OSErr;
  339.     {$IFC NOT GENERATINGCFM}
  340.     INLINE $203C, $0008, $0779, $AA5D;
  341.     {$ENDC}
  342. {
  343.  ------------------------------------------------------ FILE SIGN & VERIFY CALLS ---------------------------------------------------- 
  344. These calls allow you to detect the presence of a standard signtaure in a file as 
  345. well as sign and verify files in a standard way.  An example of this is the Finder, 
  346. which uses these calls to allow the user to "drop sign" a file.
  347.  
  348. To detect if a file is signed in the standard way, pass the FSSpec of the file to SIGFileIsSigned.
  349. A result of noErr means the file is in fact signed, otherwise, a kSIGNoSignature error will
  350. be returned.
  351.  
  352. Once you have created a SIGContextPtr, you can make calls to either sign or verify a file in
  353. a standard way: 
  354.  
  355. To sign a file, call SIGSignPrepare followed by 'n' number of calls to SIGSignFile,
  356. passing it the file spec for each file you wish to sign in turn.  You supply the context, the signature 
  357. size that was returned from SIGSignPrepare and an optional call back proc.  The call will take care of all
  358. the processing of data and affixing the signature to the file. If a signature already exists in the file, 
  359. it is replaced with the newly created signature.
  360.  
  361. To verify a file that was signed using SIGSignFile, call SIGVerifyFile passing it a new context and 
  362. the file spec.  Once this call has completed, if the verification is successfull, you can pass the context 
  363. to SIGShowSigner to display the name of the person who signed the file.
  364. }
  365. FUNCTION SIGFileIsSigned({CONST}VAR fileSpec: FSSpec): OSErr;
  366.     {$IFC NOT GENERATINGCFM}
  367.     INLINE $203C, $0002, $09C4, $AA5D;
  368.     {$ENDC}
  369. FUNCTION SIGSignFile(context: SIGContextPtr; signatureSize: Size; {CONST}VAR fileSpec: FSSpec; statusProc: SIGStatusProcPtr): OSErr;
  370.     {$IFC NOT GENERATINGCFM}
  371.     INLINE $203C, $0008, $09C5, $AA5D;
  372.     {$ENDC}
  373. FUNCTION SIGVerifyFile(context: SIGContextPtr; {CONST}VAR fileSpec: FSSpec; statusProc: SIGStatusProcPtr): OSErr;
  374.     {$IFC NOT GENERATINGCFM}
  375.     INLINE $203C, $0006, $09C6, $AA5D;
  376.     {$ENDC}
  377. {$ENDC}
  378. {$ALIGN RESET}
  379. {$POP}
  380.  
  381. {$SETC UsingIncludes := DigitalSignatureIncludes}
  382.  
  383. {$ENDC} {__DIGITALSIGNATURE__}
  384.  
  385. {$IFC NOT UsingIncludes}
  386.  END.
  387. {$ENDC}
  388.